Nullification
Domain Message Specification

Version: 2.2; Status: Final

EntitySDSWithRequiredRoleProfileId Tabular View

COCD_TP145022UK02
AssignedEntitySDS

This template is used to identify a person and their role within an organisation.

Full details of the person are available from SDS but the relevant role profile may not be available or cannot be determined.

This class identifies a person playing the role.
Used by:
[1..1] [M] classCode (CS { CNE: RoleClass } )
{ Fixed="ASSIGNED" }

Model Attribute Description

The HL7 attribute classCode describes this class as an assigned role. An assigned role is a type of agent in which, the player is a person employed by a scoping organisation.

Implementation in XML Instance

The XML attribute classCode is fixed to " ASSIGNED".
[1..1] [R] code (CV { CWE:SDSJobRoleName } )
Model Attribute Description

The HL7 attribute code uses a code from any available vocabulary to describe the person job role.

Implementation in XML Instance

The Coded Plain flavour of the Coded Value (CV) data type shall be used to carry this information in the XML element code as follows:

When the SDSJobRoleName vocabulary is used then:

  • The XML attribute code shall contain the code from theSDSJobRoleName vocabulary
  • The XML attribute codeSystem shall contain the OID "2.16.840.1.113883.2.1.3.2.4.17.196"
  • The XML attribute displayName shall carry the description associated with the code in the SDSJobRoleName vocabulary
When an alternative vocabulary is used and an OID is available then:
  • The XML attribute code shall contain the code from the alternative vocabulary
  • The XML attribute codeSystem shall contain the OID for the alternative vocabulary
  • The XML attribute displayName shall carry the description from the alternative vocabulary

When an alternative vocabulary is used and no OID is available then:

  • The XML attribute code shall contain the code from the alternative vocabulary
  • The XML attribute codeSystem shall contain the OID "2.16.840.1.113883.2.1.3.2.4.17.339"
  • The XML attribute displayName shall carry the description from the alternative vocabulary
[1..2] [M] id (SET<II>)

Model Attribute Description

The HL7 attribute id uses one or more identifiers to identify the person.

Implementation in XML Instance

The first instance of the XML element id is mandatory and shall carry the SDS User ID, the second instance of XML element id is required and shall carry the SDS User Role Profile ID when available on the sending system. The identifiers shall be carried in the XML element id as follows:
The first instance of the XML element id shall carry an SDS identifier that uniquely identifies the person as follows:
  • The XML attribute root shall contain the OID "1.2.826.0.1285.0.2.0.65"
  • The XML attribute extension shall contain the SDS User ID
The second instance of the XML element id shall carry the SDS identifier that uniquely identifies the role profile of the person as follows:
  • The XML attribute root shall contain an OID with the value "1.2.826.0.1285.0.2.0.67"
  • The XML attribute extension shall contain the SDS Role Profile ID

When the role profile id is not known then the XML attribute nullFlavor of the second XML element id shall contain the value "UNK".
[1..1] [M] templateId (II)
{ Fixed="COCD_TP145022UK02#AssignedEntitySDS" }
Model Attribute Description

The HL7 attribute templateId provides a unique identifier for the template and the class name within that template. This is used to identify how the CDA standard has been constrained for NHS use.

Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
  • The XML attribute extension is fixed to "COCD_TP145022UK02#AssignedEntitySDS"
[1..1] [M] assignedPerson (Person)

A link to the person entity which is playing this role.
[0..1] representedOrganization (Organization)
A link to the organisation.
Person

A class which details the person who is playing the role.
Used by: AssignedEntitySDS
[1..1] [M] classCode (CS { CNE: EntityClass } )
{ Fixed="PSN" }

Model Attribute Description

The HL7 attribute classCode describes this class as a person.

Implementation in XML Instance

The XML attribute classCode is fixed to " PSN".
[1..1] [M] determinerCode (CS { CNE: EntityDeterminer } )
{ Fixed="INSTANCE" }

Model Attribute Description

The HL7 attribute determinerCode describes this class as an instance of a person.

Implementation in XML Instance

The XML attribute determinerCode is fixed to " INSTANCE".
[1..1] [M] name (PN)

Model Attribute Description

The HL7 attribute name provides a name associated with the person.

Implementation in XML Instance

The Person Name Structured with optional Use and optional Valid Time flavour of the PN data type is the recommended format for the person's name. This information is carried in the XML element name as follows:

  • The XML element prefix should contain the person's title
  • The XML element given should contain the person's forenames; there can be as many occurrences of the XML element as required
  • The XML element family should contain the person's surname
  • The XML element suffix may contain any suffix for the person

Additionally the XML attribute use of the XML element name should be used to indicate the type of name; the recommended codes to be used are listed below:

Note some of the codes listed are NHS extensions, these are marked with an *

Code Definition
L
 Legal
PREFERRED *
 Preferred name

Additionally the XML element validTime of the XML element name may be used to indicate the time when the name is valid/was valid for the person, some uses are shown below:

  • A point in time when the name details are known to be valid
  • A start and end time
    • To represent the period of time the person is/was known by this name
  • A start time only to indicate when the name is/was valid from for the person
  • An end time only to indicate that the name is/was only valid for the person until a certain date

[1..1] [M] templateId (II)
{ Fixed="COCD_TP145022UK02#assignedPerson" }
Model Attribute Description

The HL7 attribute templateId provides a unique identifier for the template and the class name within that template. This is used to identify how the CDA standard has been constrained for NHS use.

Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
  • The XML attribute extension is fixed to "COCD_TP145022UK02#assignedPerson"
Organization

Details to allow identification of the organization which is responsible for the role.
Used by: AssignedEntitySDS
[1..1] [M] classCode (CS { CNE: EntityClass } )
{ Fixed="ORG" }

Model Attribute Description

The HL7 attribute classCode describes this class as an organisation.

Implementation in XML Instance

The XML attribute classCode is fixed to "ORG".

[1..1] [M] determinerCode (CS { CNE: EntityDeterminer } )
{ Fixed="INSTANCE" }

Model Attribute Description

The HL7 attribute determinerCode describes this class as an instance of an organisation.

Implementation in XML Instance

The XML attribute determinerCode is fixed to "INSTANCE".

[1..1] [M] id (II)

Model Attribute Description

The HL7 attribute id uses an ODS code as an identifier that uniquely identifies the organisation which employs the person in the role. The ODS code should identify the organisation at either the site level or organisation level. Where possible the organisation should be identified at the site level. ODS codes were formerly known as NACS codes.

Implementation in XML Instance

When ODS site code is used then the XML element id is populated in the following way:

  • The XML attribute root shall contain an OID with the value "2.16.840.1.113883.2.1.3.2.4.19.2"
  • The XML attribute extension shall contain the ODS site code

When ODS organisation code is used then the XML element id is populated in the following way:

  • The XML attribute root shall contain an OID with the value "2.16.840.1.113883.2.1.3.2.4.19.1"
  • The XML attribute extension shall contain the ODS organisation code
[1..1] [M] name (ON)

Model Attribute Description

The HL7 attribute name uses the description of the organisation associated with the ODS code.

Implementation in XML Instance

The XML element name will carry the description associated with the ODS code carried in the XML attribute extension of the XML element id.
[1..1] [M] templateId (II)
{ Fixed="COCD_TP145022UK02#representedOrganization" }

Model Attribute Description

The HL7 attribute templateId provides a unique identifier for the template and the class name within that template. This is used to identify how the CDA standard has been constrained for NHS use.

Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:

  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
  • The XML attribute extension is fixed to "COCD_TP145022UK02#representedOrganization".